Pro-Cloud API Web Service
Method/ProCloudWS.asmx/CreateActivityForNewServiceUser
Pro-Cloud API Web Service > All Operations Resource Group : /ProCloudWS.asmx/CreateActivityForNewServiceUser (Method)
Description
This web method allows to create an activity for a new service user that currently does not exists in the system. Service User name, contact details and address details will be required in order to raise a hire delivery in the system. TypeId (15) will allow users to create a hire request for an asset. "ActivityTypeGet" web method returns all available Activity Types. Similarly, Activity Response Time can also be determined from "ResponseTimesGet" Web Method in order to raise an activity with appropriate speed code.
Request (CreateActivityForNewServiceUserSoapIn)

The request body is of type CreateActivityForNewServiceUser.

Request Body Parameters

NameDescriptionData Type
objProviderGUId

This is a unique provider id, which can be obtained from CSS

GUId

guid
strPassword

This is your unique service password which can be obtained from CSS

String (min 1 max 50)

xml:string
intProviderBranchId

This is the providers branch making the web service call (can be obtained via the ProviderBranchesGet web method)

Integer

xml:int
strFirstname

This is a service user firstname which is not in the system.

String (min 1 max 75)

 

xml:string
strSurname

This is a service user surname which is not in the system.

String (min 1 max 75)

 

xml:string
strWorkNumber

This is a service user work phone number if available.

String (min 1 max 20)

 

xml:string
strMobileNumber

This is a service user mobile number if available.

String (min 1 max 20)

xml:string
strEmailAddress

This is a service user email address (mandatory).

String (min 1 max 100)

xml:string
strSubDwelling

This is a service user sub dwelling address field.

String (min 1 max 100)

xml:string
strBuildingNameNumber

This is a service user house name or number address field.

String (min 1 max 100)

xml:string
strStreet

This is a service user street address field.

String (min 1 max 60)

xml:string
strLocality

This is a service user locality address field.

String (min 1 max 100)

xml:string
strTown

This is a service user town address field.

String (min 1 max 60)

xml:string
strCounty

This is a service user county address field.

String (min 1 max 60)

xml:string
strPostcode

This is a service user postcode address field.

String (min 1 max 11)

xml:string
intTypeId

This is an activity type field to raise a hire delivery request for a service user. 

e.g TypeId 15 - hire delivery.

xml:int
strActivityNotes

This field contains any paticular activity notes user wants to add while raisng a hire request. Notes will be visible when viewing this activity.

String (min 1 max 400)

xml:string
strUniqueStockRefs

This is an EIN/Unique Stock Reference you want to hire. Please note that you can raise an activity for multiple EINS/Unique Stock References with  ";" seperation. You can find EINS/Unique Stock References by using other web methods within Pro-Cloud API. Please note that a valid Unique Stock Reference is required to create an activity. The following EINS are already used for testing purposes.

e.g. 113-35;113-34;113-36;113-37;

String (min 1 to varchar(max) )

 

xml:string
intResponseId

This is a response time field which generates a target date for an activity. "ResponseTimesGet" Web Method returns all available response times ids with descriptions within a contract. Please use "ResponseTimesGet" Web Service to fnd acorrect ResponseId.

e.g. 4179 - Courier Delivery

Integer

xml:int
intResponseId Element strUniqueStockRefs Element strActivityNotes Element intTypeId Element strPostcode Element strCounty Element strTown Element strLocality Element strStreet Element strBuildingNameNumber Element strSubDwelling Element strEmailAddress Element strMobileNumber Element strWorkNumber Element strSurname Element strFirstname Element intProviderBranchId Element strPassword Element objProviderGUId Element Sequence CreateActivityForNewServiceUser Element

Overview

CreateActivityForNewServiceUser
Sequence
objProviderGUId guid Simple Type
strPassword optional xs:string
intProviderBranchId xs:int
strFirstname optional xs:string
strSurname optional xs:string
strWorkNumber optional xs:string
strMobileNumber optional xs:string
strEmailAddress optional xs:string
strSubDwelling optional xs:string
strBuildingNameNumber optional xs:string
strStreet optional xs:string
strLocality optional xs:string
strTown optional xs:string
strCounty optional xs:string
strPostcode optional xs:string
intTypeId xs:int
strActivityNotes optional xs:string
strUniqueStockRefs optional xs:string
intResponseId xs:int
Response (CreateActivityForNewServiceUserSoapOut)

The response body is of type CreateActivityForNewServiceUserResponse.

Response Body Parameters

NameDescriptionData Type
CreateActivityForNewServiceUserResult objCreateActivityForNewServiceUserReturn
xmlDataSet Element strErrorMsg Element intErrorId Element Sequence CreateActivityForNewServiceUserResult Element Sequence CreateActivityForNewServiceUserResponse Element

Overview

CreateActivityForNewServiceUserResponse
Sequence
Example
<?xml version="1.0" encoding="utf-8"?>
<objCreateActivityForNewServiceUserReturn xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://pro-cloud.org/">
  <intErrorId>0</intErrorId>
  <strErrorMsg />
  <xmlDataSet>
    <NewDataSet xmlns="">
      <CreateActivityForNewServiceUser>
        <ActivityId>344996</ActivityId>
        <ActivityGUId>EE3E052A-B8D5-4BE8-B291-35617DF37A6E</ActivityGUId>
        <ServiceUserId>154305</ServiceUserId>
        <ServiceUserGUId>2D02B9AE-8895-4DA1-87B8-AFCE1CC8E5FF</ServiceUserGUId>
      </CreateActivityForNewServiceUser>
    </NewDataSet>
  </xmlDataSet>
</objCreateActivityForNewServiceUserReturn>
See Also
All Operations Resource Group | Pro-Cloud API Web Service

 

 

© 2021 All Rights Reserved.

Send comments on this topic.